<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: KVNavigableMap.html 602 2015-01-05 18:49:18Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.util;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.Collections;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.Comparator;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.NavigableMap;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.jsimpledb.kv.KVPair;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.jsimpledb.kv.KVStore;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.jsimpledb.kv.KeyFilter;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.jsimpledb.kv.KeyRange;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.jsimpledb.util.Bounds;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.jsimpledb.util.ByteReader;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.jsimpledb.util.ByteUtil;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.jsimpledb.util.ByteWriter;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * A {@link java.util.NavigableMap} view of the keys and values in a {@link KVStore}.<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Instances are mutable, with these exceptions:<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;ul&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *  &lt;li&gt;{@link #clear} is not supported when a {@link KeyFilter} is configured&lt;/li&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;/ul&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span>@SuppressWarnings("serial")<a name="line.31"></a>
<span class="sourceLineNo">032</span>public class KVNavigableMap extends AbstractKVNavigableMap&lt;byte[], byte[]&gt; {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>// Constructors<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>    /**<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * Constructor for when there are no range restrictions.<a name="line.37"></a>
<span class="sourceLineNo">038</span>     *<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * @param kv underlying {@link KVStore}<a name="line.39"></a>
<span class="sourceLineNo">040</span>     */<a name="line.40"></a>
<span class="sourceLineNo">041</span>    public KVNavigableMap(KVStore kv) {<a name="line.41"></a>
<span class="sourceLineNo">042</span>        this(kv, false, null, null);<a name="line.42"></a>
<span class="sourceLineNo">043</span>    }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>    /**<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * Constructor for when the range of visible {@link KVStore} keys is all keys sharing a given {@code byte[]} prefix.<a name="line.46"></a>
<span class="sourceLineNo">047</span>     *<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * @param kv underlying {@link KVStore}<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @param prefix prefix defining minimum and maximum keys<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @throws NullPointerException if {@code prefix} is null<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    public KVNavigableMap(KVStore kv, byte[] prefix) {<a name="line.52"></a>
<span class="sourceLineNo">053</span>        this(kv, false, KeyRange.forPrefix(prefix), null);<a name="line.53"></a>
<span class="sourceLineNo">054</span>    }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /**<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * Primary constructor.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     *<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @param kv underlying {@link KVStore}<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @param reversed whether ordering is reversed<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @param keyRange key range restriction, or null for none<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * @param keyFilter key filter, or null for none<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * @throws IllegalArgumentException if {@code kv} is null<a name="line.63"></a>
<span class="sourceLineNo">064</span>     */<a name="line.64"></a>
<span class="sourceLineNo">065</span>    protected KVNavigableMap(KVStore kv, boolean reversed, KeyRange keyRange, KeyFilter keyFilter) {<a name="line.65"></a>
<span class="sourceLineNo">066</span>        this(kv, reversed, keyRange, keyFilter, KVNavigableSet.createBounds(keyRange));<a name="line.66"></a>
<span class="sourceLineNo">067</span>    }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    /**<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * Internal constructor. Used for creating sub-maps and reversed views.<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * @param kv underlying {@link KVStore}<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @param reversed whether ordering is reversed (implies {@code bounds} are also inverted)<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * @param keyRange key range restriction, or null for none<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * @param keyFilter key filter, or null for none<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @param bounds range restriction<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @throws IllegalArgumentException if {@code kv} or {@code bounds} is null<a name="line.77"></a>
<span class="sourceLineNo">078</span>     */<a name="line.78"></a>
<span class="sourceLineNo">079</span>    private KVNavigableMap(KVStore kv, boolean reversed, KeyRange keyRange, KeyFilter keyFilter, Bounds&lt;byte[]&gt; bounds) {<a name="line.79"></a>
<span class="sourceLineNo">080</span>        super(kv, false, reversed, keyRange, keyFilter, bounds);<a name="line.80"></a>
<span class="sourceLineNo">081</span>    }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>// Methods<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>    @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span>    public Comparator&lt;byte[]&gt; comparator() {<a name="line.86"></a>
<span class="sourceLineNo">087</span>        return this.reversed ? Collections.reverseOrder(ByteUtil.COMPARATOR) : ByteUtil.COMPARATOR;<a name="line.87"></a>
<span class="sourceLineNo">088</span>    }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>    @Override<a name="line.90"></a>
<span class="sourceLineNo">091</span>    public byte[] put(byte[] key, byte[] value) {<a name="line.91"></a>
<span class="sourceLineNo">092</span>        if (!this.isVisible(key))<a name="line.92"></a>
<span class="sourceLineNo">093</span>            throw new IllegalArgumentException("key is out of range or filtered out");<a name="line.93"></a>
<span class="sourceLineNo">094</span>        final byte[] previousValue = this.kv.get(key);<a name="line.94"></a>
<span class="sourceLineNo">095</span>        this.kv.put(key, value);<a name="line.95"></a>
<span class="sourceLineNo">096</span>        return previousValue;<a name="line.96"></a>
<span class="sourceLineNo">097</span>    }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>    @Override<a name="line.99"></a>
<span class="sourceLineNo">100</span>    public byte[] remove(Object obj) {<a name="line.100"></a>
<span class="sourceLineNo">101</span>        if (!(obj instanceof byte[]))<a name="line.101"></a>
<span class="sourceLineNo">102</span>            return null;<a name="line.102"></a>
<span class="sourceLineNo">103</span>        final byte[] key = (byte[])obj;<a name="line.103"></a>
<span class="sourceLineNo">104</span>        if (!this.isVisible(key))<a name="line.104"></a>
<span class="sourceLineNo">105</span>            return null;<a name="line.105"></a>
<span class="sourceLineNo">106</span>        final byte[] previousValue = this.kv.get(key);<a name="line.106"></a>
<span class="sourceLineNo">107</span>        if (previousValue != null)<a name="line.107"></a>
<span class="sourceLineNo">108</span>            this.kv.remove(key);<a name="line.108"></a>
<span class="sourceLineNo">109</span>        return previousValue;<a name="line.109"></a>
<span class="sourceLineNo">110</span>    }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    @Override<a name="line.112"></a>
<span class="sourceLineNo">113</span>    public void clear() {<a name="line.113"></a>
<span class="sourceLineNo">114</span>        this.navigableKeySet().clear();<a name="line.114"></a>
<span class="sourceLineNo">115</span>    }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>    @Override<a name="line.117"></a>
<span class="sourceLineNo">118</span>    public boolean containsKey(Object obj) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>        if (!(obj instanceof byte[]))<a name="line.119"></a>
<span class="sourceLineNo">120</span>            return false;<a name="line.120"></a>
<span class="sourceLineNo">121</span>        final byte[] key = (byte[])obj;<a name="line.121"></a>
<span class="sourceLineNo">122</span>        if (!this.isVisible(key))<a name="line.122"></a>
<span class="sourceLineNo">123</span>            return false;<a name="line.123"></a>
<span class="sourceLineNo">124</span>        return this.kv.get(key) != null;<a name="line.124"></a>
<span class="sourceLineNo">125</span>    }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>    @Override<a name="line.127"></a>
<span class="sourceLineNo">128</span>    protected void encodeKey(ByteWriter writer, Object obj) {<a name="line.128"></a>
<span class="sourceLineNo">129</span>        if (!(obj instanceof byte[]))<a name="line.129"></a>
<span class="sourceLineNo">130</span>            throw new IllegalArgumentException("key is not a byte[]");<a name="line.130"></a>
<span class="sourceLineNo">131</span>        writer.write((byte[])obj);<a name="line.131"></a>
<span class="sourceLineNo">132</span>    }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>    @Override<a name="line.134"></a>
<span class="sourceLineNo">135</span>    protected byte[] decodeKey(ByteReader reader) {<a name="line.135"></a>
<span class="sourceLineNo">136</span>        return reader.getBytes();<a name="line.136"></a>
<span class="sourceLineNo">137</span>    }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span>    @Override<a name="line.139"></a>
<span class="sourceLineNo">140</span>    protected byte[] decodeValue(KVPair pair) {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        return pair.getValue();<a name="line.141"></a>
<span class="sourceLineNo">142</span>    }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span>    @Override<a name="line.144"></a>
<span class="sourceLineNo">145</span>    protected NavigableMap&lt;byte[], byte[]&gt; createSubMap(boolean newReversed,<a name="line.145"></a>
<span class="sourceLineNo">146</span>      KeyRange newKeyRange, KeyFilter newKeyFilter, Bounds&lt;byte[]&gt; newBounds) {<a name="line.146"></a>
<span class="sourceLineNo">147</span>        return new KVNavigableMap(this.kv, newReversed, newKeyRange, newKeyFilter, newBounds);<a name="line.147"></a>
<span class="sourceLineNo">148</span>    }<a name="line.148"></a>
<span class="sourceLineNo">149</span>}<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>




























































</pre>
</div>
</body>
</html>
